.TH std::experimental::simd_mask 3 "2024.06.10" "http://cppreference.com" "C++ Standard Libary"
.SH NAME
std::experimental::simd_mask \- std::experimental::simd_mask

.SH Synopsis
   Defined in header <experimental/simd>
   template< class T, class Abi = simd_abi::compatible<T> >  (parallelism TS v2)
   class simd_mask;

   The class template simd_mask is a data-parallel type with the element type bool. The
   width of a given simd_mask instantiation is a constant expression, determined by the
   template parameters. Specifically, simd_mask<T, Abi>::size() is always simd<T,
   Abi>::size().

.SH Template parameters

   T   - the element type simd_mask applies on
   Abi - the ABI type simd_mask applies on

   Helper alias templates

   Template                                       Definition
   template< class T, int N > using               simd_mask<T, simd_abi::fixed_size<N>>
   fixed_size_simd_mask
   template< class T > using native_simd_mask     simd_mask<T, simd_abi::native<T>>

.SH Member types

   Member type Definition
   value_type  bool
   reference   implementation-defined
   simd_type   simd<T, Abi>
   abi_type    Abi

.SH Member functions

   constructor                  constructs a simd_mask object
   (parallelism TS v2)          \fI(public member function)\fP
   copy_from                    loads simd_mask elements from contiguous memory
   (parallelism TS v2)          \fI(public member function)\fP
   copy_to                      stores simd_mask elements to contiguous memory
   (parallelism TS v2)          \fI(public member function)\fP
   operator[]                   accesses specified element
   (parallelism TS v2)          \fI(public member function)\fP
   operator!                    negates each element
   (parallelism TS v2)          \fI(public member function)\fP
   size                         returns the width / number of elements
   \fB[static]\fP (parallelism TS v2) \fI(public static member function)\fP

.SH Non-member functions

   operator&&          element-wise logic operators
   operator||          \fI(function)\fP
   (parallelism TS v2)
   operator&
   operator|           element-wise bitwise operators
   operator^           \fI(function)\fP
   (parallelism TS v2)
   operator&=
   operator|=          element-wise compound operators
   operator^=          \fI(function)\fP
   (parallelism TS v2)
   operator==          element-wise relation operators
   operator!=          \fI(function)\fP
   (parallelism TS v2)

.SH Example

    This section is incomplete
    Reason: no example

.SH See also

   simd                data-parallel vector type
   (parallelism TS v2) \fI(class template)\fP
                       proxy to a subset of a valarray after applying a boolean mask
   mask_array          operator[]
                       \fI(class template)\fP

.SH Category:
     * Todo no example
